docs(agents): add AGENTS.md, agent configs, and AI attribution policy - #48
Conversation
Introduce AGENTS.md as the shared, tool-agnostic guide and single source of truth for AI coding agents. CLAUDE.md and GEMINI.md import it, and a compact Copilot instructions file mirrors the key rules. Track the existing .cursor/rules so agent guidance ships with the repo, and guard local-only agent files in .gitignore. Document the AI attribution policy (Co-Authored-By trailers plus a PR attribution section) in AGENTS.md, CONTRIBUTING.md, and the PR template. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 35 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe PR adds repository guidance for contributors and AI coding tools, defines backend and frontend development conventions through Cursor rules, updates local configuration ignores, and bumps the frontend package version from 0.4.0 to 0.4.1. ChangesRepository guidance
Frontend release metadata
Estimated code review effort: 2 (Simple) | ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.cursor/rules/alembic-no-auto-migrations.mdc:
- Around line 13-16: Update the Alembic workflow guidance in the referenced
rule: remove the instruction to run `alembic revision` or `alembic upgrade`, and
instead tell contributors to record the model change and ask a maintainer to
generate and review the migration. Preserve the existing instructions not to
create migration files or run Alembic commands.
In @.cursor/rules/api-database-conventions.mdc:
- Around line 11-15: Update the “Model Changes Workflow” section to remove the
Alembic migration-generation and idempotency requirements. Instruct contributors
to modify and validate SQLAlchemy models only, leaving migration creation and
execution to the maintainer manually, consistent with repository policy.
In @.cursor/rules/windows-powershell.mdc:
- Around line 8-10: Correct the command guidance in the Windows PowerShell
rules: update the prohibited bash-specific examples to remove `;` and `$VAR`,
since both are valid PowerShell syntax, while retaining genuinely bash-specific
forms such as `&&`, `[[ ]]`, and `rm -rf`. Ensure the related guidance in the
sections referenced by the comment consistently recommends PowerShell command
chaining with `;`.
In `@AGENTS.md`:
- Around line 56-58: Update the four fenced code blocks in AGENTS.md, including
the block containing the commit-message format and those at the referenced
sections, by adding an appropriate language identifier such as text to each
opening fence so markdownlint MD040 passes.
- Line 3: Update the introductory source-of-truth statement in AGENTS.md to
clarify that .cursor/rules/*.mdc files are standalone mirrors that must remain
aligned with AGENTS.md, rather than pointing back to or importing it; retain the
existing import/reference wording for CLAUDE.md, GEMINI.md, and Copilot.
- Around line 27-28: Remove the Alembic command rows from the common-command
table in AGENTS.md and replace them with an explicit entry stating: “Do not run
Alembic commands; the maintainer manages migrations.” Ensure the guidance
consistently prohibits both alembic revision and alembic upgrade.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: da0ef693-e3e9-45e3-a252-e2738efa4582
⛔ Files ignored due to path filters (1)
apps/frontend/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (25)
.cursor/rules/alembic-no-auto-migrations.mdc.cursor/rules/api-authentication.mdc.cursor/rules/api-boards-elements.mdc.cursor/rules/api-database-conventions.mdc.cursor/rules/api-layer-responsibilities.mdc.cursor/rules/api-modular-architecture.mdc.cursor/rules/api-realtime-websockets.mdc.cursor/rules/api-redis.mdc.cursor/rules/api-rest-conventions.mdc.cursor/rules/excalidraw-canvas.mdc.cursor/rules/extend-dont-abstract.mdc.cursor/rules/loomy-project-context.mdc.cursor/rules/loomy-tech-stack.mdc.cursor/rules/python-standards.mdc.cursor/rules/uncodixify-ui.mdc.cursor/rules/windows-powershell.mdc.cursor/rules/yjs-sync.mdc.github/PULL_REQUEST_TEMPLATE.md.github/copilot-instructions.md.gitignoreAGENTS.mdCLAUDE.mdCONTRIBUTING.mdGEMINI.mdapps/frontend/package.json
nazarli-shabnam
added
the
documentation
Pre-existing formatting violation surfaced by prettier --check in UI CI. Formatting only, no logic change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Keep Cursor rules local and gitignored. AGENTS.md is the shared, tool-agnostic guide, so the Cursor-specific rules do not need to ship in the repo. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2 participants
Summary
Add AGENTS.md as the shared, tool-agnostic guide for the repo and wire the other
agent tools to it, so any AI coding agent and any human works from one source of
truth. Also document an AI attribution policy and start tracking the existing
Cursor rules so agent guidance ships with the repo.
Related issues
N/A
Type of change
Areas touched
Database changes
N/A
Implementation notes
AGENTS.mdis the new canonical guide, synced to the repo's current state(CODEOWNERS, pre-push hook, and the recent real-time hardening around
reconnect, Redis subscribe, cache reset, token refresh, and peer.left).
CLAUDE.mdandGEMINI.mdare thin files that import it with@AGENTS.md..github/copilot-instructions.mdis a compact self-contained mirror sinceCopilot does not follow imports.
.cursor/rules/*.mdcfiles are now tracked..gitignoreun-ignoresthe agent config and CLAUDE.md, and adds guards so local-only files such as
.claude/settings.local.jsonstay out.memory/remains ignored.template: a
Co-Authored-Bytrailer on the commit and an attribution note inthe PR description.
AI attribution
config files, updated CONTRIBUTING.md, the PR template, and .gitignore, and
wrote the commits. Reviewed by the repo maintainer.
How to test
Docs and config only. Confirm
AGENTS.mdrenders, the@AGENTS.mdimportresolves in CLAUDE.md, and the tracked
.cursor/rulesappear in the tree.Checklist
main..envfiles are committed.🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores